/**
 * This program is free software, you can redistribute it and/or modify.
 * Copyright (c) 2025 Huawei Technologies Co., Ltd.
 * This file is a part of the CANN Open Software.
 * Licensed under CANN Open Software License Agreement Version 2.0 (the "License").
 * Please refer to the License for details. You may not use this file except in compliance with the License.
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
 * See LICENSE in the root of the software repository for the full text of the License.
 */
#ifndef OP_API_INC_KTHVALUE_H_
#define OP_API_INC_KTHVALUE_H_

#include "aclnn/aclnn_base.h"
#include "aclnn_util.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnKthvalue的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_math
 *
 * 算子功能：完成计算输入的第k个最小值及下标。
 *
 * @param [in] self: npu
 * npu device侧的aclTensor，数据类型支持INT32、FLOAT16、FLOAT32。
 * 支持连续和非连续的Tensor，数据格式支持ND。
 * @param [in] k:
 * int64_t类型整数。表示计算维度上输出的第几个最小值。
 * @param [in] dim:
 * int64_t类型整数。表示计算维度。
 * @param [in] keepdim:
 * bool类型数据。True表示输出张量的大小与self相同，
 * False表示dim将被压缩，得到的张量维数比input少1。
 * @param [in] valuesOut:
 * dnpu device侧的aclTensor，数据类型支持INT32、FLOAT16、FLOAT32，且数据类型与self保持一致。
 * 支持连续和非连续的Tensor，数据格式支持ND。
 * @param [in] indicesOut:
 * npu device侧的aclTensor，数据类型支持INT64。支持连续和非连续的Tensor，数据格式支持ND。
 * @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
ACLNN_API aclnnStatus aclnnKthvalueGetWorkspaceSize(const aclTensor* self, int64_t k, int64_t dim, bool keepdim,
                                                    aclTensor* valuesOut, aclTensor* indicesOut,
                                                    uint64_t* workspaceSize, aclOpExecutor** executor);
/**
 * @brief aclnnKthvalue的第二段接口，用于执行计算。
 *
 * 算子功能：完成计算输入的第k个最小值及下标。
 *
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnKthvalueGetWorkspaceSize获取。
 * @param [in] stream: acl stream流。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
ACLNN_API aclnnStatus aclnnKthvalue(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor,
                                    const aclrtStream stream);

#ifdef __cplusplus
}
#endif

#endif  // OP_API_INC_KTHVALUE_H_
